Wave Dashboard
wave:waveDashboard
Adds a Tableau CRM dashboard to a Lightning Experience page.
For Use In
Lightning Experience
Add CRM Analytics dashboard components to Visualforce and Lightning pages to provide interactive visualizations of your data. Users can drill in and explore the dashboard within the frame on the page.
The CRM Analytics dashboard component is available in the Lightning App Builder as a drag-and-drop component, however, you can also create your own CRM Analytics dashboard component or add it a Visualforce page using wave:waveDashboard.
Here’s an example of a wave:waveDashboard component:
1<aura:component implements="force:appHostable,force:hasRecordId">
2 <wave:waveDashboard dashboardId="0FKxx000000000uGAA" />
3</aura:component>For more information, see the Embed CRM Analytics Dashboards in Lightning Pages and Add a CRM Analytics Dashboard to a Visualforce Page. For detailed use cases, see Analytics Dashboard Component Use Cases.
Attributes
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| accessToken | A valid access token obtained by logging into Salesforce. Useful when the component is used by Lightning Out in a non Salesforce domain. | String | ||
| body | The body of the component. In markup, this is everything in the body of the tag. | Aura.Component[] | ||
| dashboardId | The unique ID of the dashboard. You can get a dashboard’s ID, an 18-character code beginning with 0FK, from the dashboard's URL, or you can request it through the API. This attribute can be used instead of the developer name, but it can't be included if the name has been set. One of the two is required. | string | ||
| developerName | The unique developer name of the dashboard. You can request the developer name through the API. This attribute can be used instead of the dashboard ID, but it can't be included if the ID has been set. One of the two is required. | string | ||
| enableNotifications | Specifies whether or not users can set and manage notifications on widgets. | boolean | true | |
| enableSubscriptions | Specifies whether or not users can subscribe to widgets and manage their subscriptions. | boolean | true | |
| filter | Adds selections or filters to the embedded dashboard at runtime. The filter attribute is configured using JSON. For filtering by dimension, use this syntax: {'datasets' : {'dataset1': [ {'fields': ['field1'], 'selection': ['$value1', '$value2']}, {'fields': ['field2'], 'filter': {'operator': 'operator1', 'values': ['$value3', '$value4']}}]}}. For filtering on measures, use this syntax: {'datasets' : {'dataset1': [ {'fields': ['field1'], 'selection': ['$value1', '$value2']}, {'fields': ['field2'], 'filter': { 'operator': 'operator1', 'values': [[$value3]]}}]}}. With the selection option, the dashboard is shown with all its data, and the specified dimension values are highlighted. With the filter option, the dashboard is shown with only filtered data. For more information, see https://help.salesforce.com/articleView?id=bi_embed_lightning.htm. | string | ||
| height | Specifies the height of the dashboard, in pixels. | integer | 300 | |
| hideOnError | Controls whether or not users see a dashboard that has an error. When this attribute is set to true, if the dashboard has an error, it won’t appear on the page. When set to false, the dashboard appears but doesn’t show any data. An error can occur when a user doesn't have access to the dashboard or it has been deleted. | boolean | false | |
| isLoaded | A flag that is updated when the dashboard is fully loaded on the page | boolean | false | |
| openLinksInNewWindow | If false, links to other dashboards will be opened in the same window. | boolean | true | |
| openLocation | This option specifies where the dashboard opens if the user chooses to launch the dashboard in its own pages | String | ||
| pageId | If provided, sets the initial dashboard page. | string | ||
| recordId | Id of the current entity in the context of which the component is being displayed. | String | ||
| rendered | Specifies whether or not the component is rendered on the page. | boolean | true | |
| showHeader | If true, the dashboard is displayed with a header bar that includes dashboard information and controls. If false, the dashboard appears without a header bar. Note that the header bar automatically appears when either showSharing or showTitle is true. | boolean | true | |
| showPostToSlack | If true, the Post to Slack icon appears in the dashboard header. If false, the dashboard doesn’t include the Post to Slack icon. The default is false. | boolean | false | |
| showSharing | If true, and the dashboard is shareable, then the dashboard shows the Share icon. If false, the dashboard doesn't show the Share icon. To show the Share icon in the dashboard, the smallest supported frame size is 800 x 612 pixels. | boolean | false | |
| showTitle | If true, the dashboard’s title is included above the dashboard. If false, the dashboard appears without a title. | boolean | true |
Methods
| Name | Description | Argument Name | Argument Type | Argument Description |
|---|---|---|---|---|
| getState | Get the embedded dashboard state. | config | Object | Configuration to pass on the GET call. |
| callback | Aura.Action | The callback function to run after the getState request completes. | ||
| refresh | Rerun either all queries on the dashboard or a particular query. | config | Object | Optional configuration. |
| setState | Set the embedded dashboard state. | config | Object | Configuration to pass on the SET call. |
